Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Create README.md from Wiki content #342

Merged
merged 5 commits into from
Feb 18, 2025
Merged

Create README.md from Wiki content #342

merged 5 commits into from
Feb 18, 2025

Conversation

tfoote
Copy link
Contributor

@tfoote tfoote commented Feb 4, 2025

* The camera driver advertises a service call `<camera>/request_image` of type [polled_camera/GetPolledImage](http://www.ros.org/doc/api/polled_camera/html/srv/GetPolledImage.html).
* The client calls the service, specifying an output namespace.
* On receiving a request, the driver captures an image and returns its time stamp in the service response.
* The driver publishes (latching) the [sensor_msgs/Image](http://www.ros.org/doc/api/sensor_msgs/html/msg/Image.html) and [sensor_msgs/CameraInfo](http://www.ros.org/doc/api/sensor_msgs/html/msg/CameraInfo.html) to `<response_namespace>/image_raw` and `<response_namespace>/camera_info`.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yeah we need to get better canonical links for messages.

* **Consistency:** Client-side processing is always performed in an image callback, regardless of what type of camera is used.
* **Visibility:** Topics can be monitored in [image_view](https://index.ros.org/p/image_view/) or [rviz](https://index.ros.org/p/rviz/).
* **Reproducibility:** Topics can be [bagged](https://index.ros.org/p/rosbag/) and played back later.
* **Compression:** Can take advantage of [image_transport](https://index.ros.org/p/image_transport/) to compress images, if desired.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'd like to work to get the canonical link for packages to be the index page which is much better cross linked. It has a link directly to the API docs for each different version. We do need to get more README's ported. I'm doing this as a test of migrating content from the wiki . If we migrated to it's wiki page ( https://wiki.ros.org/image_transport) to it's README.md the link here would be much more useful. But as we're looking to wind down the wiki, we are considering a more bulk process and I'd like to do the linking with that in mind.


```bash
# Poll "my_camera" at 5 Hz, publishing in namespace my_polled_output/.
$ poller 5 camera:=my_camera output:=my_polled_output
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

is this correct ?

ros2 run polled_camera poller 5 camera:=my_camera output:=my_polled_output

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't have a clue, I'm just porting the documentation as it exists trying to apply some basic heuristics.

@ahcorde
Copy link
Collaborator

ahcorde commented Feb 14, 2025

friendly ping @tfoote

@ahcorde ahcorde merged commit a05748b into rolling Feb 18, 2025
2 checks passed
@ahcorde ahcorde deleted the tfoote-patch-1 branch February 18, 2025 11:33
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants